SharePoint Learning Kit Customization
SLK Settings

Each SharePoint site collection (SPSite) may be associated with a SharePoint Learning Kit database. (Multiple site collections can refer to the same SLK database, but there can be at most one SLK database associated with a given SharePoint site collection.) Corresponding to each site collection is a SLK Settings file, which is an XML file, stored in the SLK database, that contains the following information:

SLK ships with a default SLK Settings XML file, which is used if no custom SLK settings are required.

This section explains what's in a SLK Settings file and how SLK Settings can be updated using SharePoint Central Administration.

Customizing SLK Settings

Editing SLK settings is done as follows:

  1. In a Web browser, navigate the SharePoint Learning Kit Configuration page within SharePoint Central Administration, and download the current SLK Settings file. (See the left red ellipse in the screen shot below.)
  2. Make any desired modifications, as described below. If you're accustomed to using an XML editor such as the one included in Microsoft Visual Studio, you may want to associate the SLK Settings XML schema definition file, SlkSettings.xsd, with the SLK Settings files you edit, to provide editing support and validation. You can find a copy of SlkSettings.xsd in the SLK/MLC SDK.
  3. Upload the current SLK Settings file. (See the right red ellipse in the screen shot below.)

SLK Settings File Structure

The general structure of a SLK Settings file is as follows. Many elements are optional; see the documentation of each element for more information.

XML Outline
<Settings>

The following sections are an alphabetical reference of SLK Settings file XML elements.

<Column>

(Optional, child of <Query>, multiple allowed.) Specifies a column to return from the query. The RenderAs attribute determines if the column corresponds directly to a single LearningStore view column or if the column is computed using information from one or more LearningStore view columns—see RenderAsType Values below for more information.

Syntax
XML
<Column
Title="..."
RenderAs="..."
ViewColumnName="..."
ViewColumnName2="..."
ViewColumnName3="..."
CellFormat="..."
NullDisplayString="..."
ToolTipFormat="..."
Wrap="..." />
Attributes

Title

(string, optional.) The human-readable title of this column. For example, the Assignment List Web Part displays this value in the column header. If not provided, the value of the ViewColumnName column is used.

RenderAs

(RenderAsType, optional, default Default.) Determines what text is displayed for values in the column. Also determines if the column corresponds directly to a single LearningStore view column or if the column is computed using information from one or more LearningStore view columns.

ViewColumnName

(SchemaIdType, required.) The name of the first (and possibly only) LearningStore view column that's used to construct the text of values in this column.

ViewColumnName2

(SchemaIdType, required if specified by the RenderAs type.) The name of the second LearningStore view column that's used to construct the text of values in this column.

ViewColumnName3

(SchemaIdType, required if specified by the RenderAs type.) The name of the third LearningStore view column that's used to construct the text of values in this column.

CellFormat

(string, optional.) A String.Format-style formatting specification to apply to the cell; for example, "n2".

NullDisplayString

(string, optional.) The string to display if the value of the value of the column specified by ViewColumnName is NULL. If not provided, the default is the empty string. Note that NullDisplayString may be ignored depending on the value of the RenderAs attribute—see the RenderAsType table below.

ToolTipFormat

(string, optional.) If specified, this is a String.Format-style formatting string used to create the tooltip; for example, "Final score: {0:n2}". Formatting argument "{0}" refers to the value rendered as described in the RenderAsType Values table. If the value in the column specified by ViewColumnName is NULL then no tooltip is displayed, unless specified in the RenderAsType table.

Wrap

(boolean, optional, default true.) If specified as "false", the rendered value (see the RenderAsType table below) is not permitted to wrap to a new line, where applicable (e.g. in an HTML table).

<Condition>

(Optional, child of <Query>, multiple allowed.) Defines a condition that must be met in order for a row that's returned by the LearningStore view to be included in the query results.

Syntax
XML
<Condition
ViewColumnName="..."
Operator="..."
Value="..."
MacroName="..."
NoConditionOnNull="..." />
Attributes

ViewColumnName

(SchemaIdType, required.) The name of the LearningStore view column to use in the condition.

Operator

(ConditionOperator, required.) Specifies the operator to use when comparing a value in the LearningStore view column with the value specified by the Value or MacroName attribute.

Value

(string, optional.) The value to compare LearningStore view column values with.

MacroName

(MacroNameType, optional.) The name of a "macro"—essentially a variable—provided by the application (e.g. Assignment List Web Part). The value of this macro is the value to compare LearningStore view column values with.

NoConditionOnNull

(boolean, optional, default false.) If true, then this condition is ommitted if the value is NULL.

<IncludeQuery>

(Optional, child of <QuerySet>, multiple allowed.) Specifies a query to include in a query set.

Syntax
XML
<IncludeQuery
QueryName="...">
Attributes

QueryName

(NameType, required.) The Name attribute of the <Query> element to include in the query set.

<MimeTypeMapping>

(Optional, child of <Settings>, multiple allowed.) Defines the MIME type that is included in the HTTP header by the session frameset for files with a given extension.

Syntax
XML
<MimeTypeMapping
Extension="..."
MimeType="...">
Attributes

Extension

(string, required.) The extension, including the leading "."; for example, ".txt".

MimeType

(string, required.) The MIME type; for example, "text/plain".

<Query>

(Optional, child of <Settings>, multiple allowed.) Specifies a LearningStore query on a particular LearningStore view. (The view contains a superset of the information returned by the query; the query indicates columns to use from the view, as well as conditions that specify which rows to return.) Assignment List Web Part allows the user to select a query to execute; the results are formatted (see RenderAsType below) and displayed within an iframe. All <Query> elements must appear before any <QuerySet> element.

Syntax
XML
<Query
CountViewColumnName="..."
Name="..."
Title="..."
ViewName="...">
<Column>...</Column>
<Condition>...</Condition>
<Sort>...</Sort>
</Query>
Attributes

CountViewColumnName

(SchemaIdType, optional.) The name of a column in the LearningStore view specified by the ViewName attribute that can be used when the application needs to determine the number of rows returned in a query. In that situation, the query must include one column—any column will do—and it helps performance to make that column be one that contains small data (such as a boolean or integer column). If CountViewColumnName is not specified, the application will use the first column specified on child <Column> elements when creating count-only queries.

Name

(NameType, required.) A name for the query, used to refer to the query from a <QuerySet> element, a Web Part in SharePoint, etc. No <Query> element may have the same Name attribute value as any other <Query> or <QuerySet> element.

Title

(string, optional.) The human-readable title of the query. For example, Assignment List Web Part displays this value as the query title in the list of queries in the left pane of the Web Part. If not provided, the value of the Name attribute is used.

ViewName

(SchemaIdType, required.) The name of the LearningStore view that this query executes. For example, "LearnerAssignmentListForLearners".

<QuerySet>

(Optional, child of <Settings>, multiple allowed.) Specifies a query set, which is a collection of one or more queries. The queries displayed by Assignment List Web Part are those contained within a single query set. All <QuerySet> elements must appear after any <Query> element.

Syntax
XML
<QuerySet
DefaultQueryName="..."
Name="..."
Title="...">
<IncludeQuery>...</IncludeQuery>
</QuerySet>
Attributes

DefaultQueryName

(NameType, optional.) The Name attribute of the child <IncludeQuery> element that defines the query that's displayed by default. If not provided, the first <IncludeQuery> is used.

Name

(NameType, required.) A name for the query set, used to refer to the query set from a Web Part in SharePoint etc. No <QuerySet> element may have the same Name attribute value as any other <QuerySet> or <Query> element. (If an application requests a query set using a name that's actually a query name, a query set containing only that query is constructed automatically.)

Title

(string, optional.) The human-readable title of the query set. If not provided, the value of the Name attribute is used.

<Settings>

(Optional, root element, multiple allowed.) The root XML element of the SLK Settings file.

Syntax
XML
<Settings xmlns="urn:schemas-microsoft-com:sharepoint-learning-kit:settings"
ApprovedAttachmentTypes="..."
ELearningIisCompatibilityModeExtensions="..."
LoggingOptions="..."
MaxAttachmentKilobytes="..."
NonELearningIisCompatibilityModeExtensions="..."
PackageCacheExpirationMinutes="..."
PackageCacheLocation="..."
UserWebListMruSize="..." />
<MimeTypeMapping>...</MimeTypeMapping>
<Query>...</Query>
<QuerySet>...</QuerySet>
</Settings>
Attributes

ApprovedAttachmentTypes

(string, required.) The collection of approved attachment file name extensions. These are the extensions of file types that learners are allowed to attach to an attachment-type questions in Class Server content. This is a comma-delimited list of extensions without leading periods; for example, "txt, jpg".

ELearningIisCompatibilityModeExtensions

(string, optional.) The collection of file extensions for files that should be downloaded to a client in IIS compability mode. That is, these files will be sent in a way similar to how IIS sends the files, but this may cause a decrease in performance. Applies to files within e-learning packages (SCORM and Class Server). This is a comma-delimited list of extensions without leading periods; for example, "txt, jpg".

LoggingOptions

(LoggingOptions, required.) Defines the level of logging that's performed within learning sessions. Logging may be useful to show how content is being sequenced, and to help debug sequencing problems within SCORM content. Log entries are written to the SequencingLogEntryItem table within the SLK database. Changing the LoggingOptions attribute affects only SCORM assignments that are begun after the SLK Settings file is uploaded.

MaxAttachmentKilobytes

(int, required.) The maximum size of a file that a learner may attach to an attachment-type question in Class Server content, measured in kilobytes.

NonELearningIisCompatibilityModeExtensions

(string, optional.) The collection of file extensions for files that should be downloaded to a client in IIS compability mode. That is, these files will be sent in a way similar to how IIS sends the files, but this may cause a decrease in performance. Applies to non-e-learning documents. This is a comma-delimited list of extensions without leading periods; for example, "txt, jpg".

PackageCacheExpirationMinutes

(int, optional.) The minimum amount of time that a package is retained in the SharePoint Learning Kit file system cache, measured in minutes. If "PackageCacheExpirationMinutes" is absent, packages are never removed from the cache.

PackageCacheLocation

(string, required.) The full path to the SharePoint Learning Kit package cache location used for each front-end server. This path can be a network file share so multiple front-end servers can use the same package cache. This path may contain environment variable references such as "%TEMP%".

UserWebListMruSize

(int, required.) The maximum number of Web sites displayed in the most-recently-used list of Web sites in the SharePoint Learning Kit E-Learning Actions page. All Web site references are retained, and the user can display them by clicking a link to see the complete list. The MRU is just the most-recently-used subset of Web sites that's displayed by default.

<Sort>

(Optional, child of <Column>, multiple allowed.) Specifies a LearningStore view column to sort by. If multiple <Sort> elements are provided, they are applied in the order present. If no <Sort> is provided, the order of rows returned by the query is undetermined.

Syntax
XML
<Sort
Ascending="..."
ViewColumnName="..." />
Attributes

Ascending

(boolean, optional, default true.) Specifies the direction of the sort: ascending if true, descending if false.

ViewColumnName

(SchemaIdType, required.) The name of the LearningStore view column to sort by.

ConditionOperator Values

A value of type "ConditionOperator" is a token with the same name as one of the members of the LearningStoreConditionOperator enumeration: Equal, GreaterThan, GreaterThanEqual, LessThan, LessThanEqual, NotEqual, IsNull, and IsNotNull.

LoggingOptions Values

A value of type "LoggingOptions" is a token with the same name as one of the members of the LoggingOptions enumeration: LogAll, LogAllSequencing, LogDetailSequencing, LogFinalSequencing, LogRollup, and None.

MacroNameType Values

Assignment List Web Part allows the following macros to be used within MacroName attributes of <Condition> operators. Note that all DateTime macro values are represented in UTC, since UTC is used for almost all DateTime values in the SLK database. However, "today" and "this week" refer to local time converted to UTC; for example in a GMT-08:00 time zone, if the local date/time is noon on March 15, "today" begins at 16:00 UTC on March 14 (i.e. midnight March 15 local time) and ends at 16:00 UTC on March 15 (i.e. midnight March 16 local time). This conversion is generally transparent (assuming all servers in the SLK server farm have synchronized clocks and time zones), since when data is stored in, or compared with, the SLK database it is converted from local time to UTC, and when data is searched or retrieved it is converted back to local time. Note that if a user in one time zone accesses an SLK server in another time zone, the definition of "today", "next week", etc. reflect the server's time zone, not the user's.

Also, although the DateTime macro values represent instantaneous points in time, midnight is conventionally at the beginning of a day, not the end. Therefore, "today" is defined as times that satisfy the following expression: StartOfToday <= time < StartOfTomorrow.

Macro Type Description
SPWebScope Guid The SPWeb that the query should be scoped to, or null if the query should apply to the entire database.
CurrentUser UserItemIdentifier The browser user.
Now DateTime The current date and time.
StartOfToday DateTime The point in time that today begins, i.e. midnight today.
StartOfTomorrow DateTime The point in time that tomorrow begins, i.e. midnight tomorrow.
StartOfThisWeek DateTime The point in time that this week begins. For typical US English server settings, this is midnight of the preceding Sunday (or today if today is Sunday).
StartOfNextWeek DateTime The point in time that next week begins. For typical US English server settings, this is midnight of the following Sunday.
StartOfWeekAfterNext DateTime The point in time that the week after next begins. For typical US English server settings, this is midnight of the Sunday after the following Sunday.
NameType Values

A value of type "NameType" is a string of one to 63 letters (A-Z or a-z) and digits (0-9), beginning with a letter

RenderAsType Values

A value of type "RenderAsType" is one of the following tokens:

Token What's Displayed Sort Behavior
Default (default value) The ViewColumnName value is converted to a string, HTML-encoded, and displayed as normal text.
  • ViewColumnName = Any value.
The FormatString attribute (if any) is applied to the value of ViewColumnName before HTML encoding occurs. For example, if FormatString is "M/d h:mm tt" and the column type is DateTime, the column is formatted as in this example: 3/7 4:30 PM.
Sort alphabetically by the rendered string. The sort is case-insensitive. Blank cells (i.e. DBNull values) sort the same as empty strings.
LearnerAssignmentStatus The status corresponding to the learner assignment state, displayed as follows:
LearnerAssignmentState What's Displayed
NotStarted "Not Started"
Active "In Progress"
Completed "Submitted"
Final "Final"
  • ViewColumnName = A LearnerAssignmentState value (e.g. LearnerAssignmentState column in LearnerAssignmentListForLearners).
The FormatString and NullDisplayString attributes are ignored.
Sort status by workflow state, ascending order is "Not Started", "In Progress", "Completed", and "Final".
Link A link to another page, as defined by the application. For example, in Assignment List Web Part this is always a link that opens either the Lobby page (for queries that result in a list of learner assignments) or the Grading page (for queries that result in a list of assignments).
  • ViewColumnName = assignment title (e.g. AssignmentTitle column in LearnerAssignmentListForLearners).
  • ViewColumnName2 = the AssignmentItemIdentifier or LearnerAssignmentItemIdentifier of the assignment or learner assignment to link to (e.g. LearnerAssignmentId column in LearnerAssignmentListForLearners).
The FormatString attribute is ignored.
Sort alphabetically by the rendered string. The sort is case-insensitive.
ScoreAndPossible The number of points the learner received (if applicable) and the number of points possible for the assignment (if applicable); for example, "7/10".
  • ViewColumnName = the number of points the learner received (e.g. FinalPoints column in LearnerAssignmentListForLearners); may be NULL if the assignment does not award points, or if the assignment hasn't been graded.
  • ViewColumnName2 = the nominal maximum number of points that learners may receive on the assignment (e.g. AssignmentPointsPossible column in LearnerAssignmentListForLearners); may be NULL if not applicable.
Points received and points possible values are rounded to two decimal places in the rendered text (but not in the tooltip). Additionally, the FormatString attribute (if any) is applied to the points received and points possible values. For example, if FormatString is "n0", the values are rounded to the nearest integer-but that formatting doesn't apply to the tooltip. The NullDisplayString attribute is ignored.
Sort by points divided by points possible in increasing numerical order for an ascending sort. If points is null, then sort as 0. If points possible is null, just use the numerator.
SPWebName The name of an SPWeb specified as follows:
  • ViewColumnName = SPWeb GUID (e.g. AssignmentSPWebGuid column in LearnerAssignmentListForLearners).
  • ViewColumnName2 = SPSite GUID (e.g. AssignmentSPSiteGuid column in LearnerAssignmentListForLearners).
The FormatString and NullDisplayString attributes are ignored.
Sort alphabetically by SPWeb name string. The sort is case-insensitive.
Submitted The number of learner assignments submitted and the number of learner assignments for the assignment; for example, "10/12". Each value is an integer. Neither value can be NULL. Sort by the number of learner assignments submitted-or-returned in increasing numerical order with zero submitted listed first in an ascending sort.
UtcAsLocalDateTime The ViewColumnName value is a DateTime stored in UTC (GMT) time. The date/time is converted to local time, converted to a string, HTML-encoded, and displayed as normal text.
  • ViewColumnName = UTC date/time.
The FormatString attribute (if any) is applied to the value of ViewColumnName before HTML encoding occurs. For example, if FormatString is "M/d h:mm tt", the column is formatted as in this example: 3/7 4:30 PM.
Sort by date in ascending order (with the earliest due date listed first) and list assignments without dates below those with dates.
SchemaIdType Values

A value of type "SchemaIdType" is a string of one to 63 letters (A-Z or a-z) and digits (0-9), beginning with a letter.

For More Information
SLK Concepts
SLK Queries and Query Sets
SLK+MLC Schema
SLK API
Next Topic: SLK API Overview